Skip to content

Docs: integrate search with Pagefind instead of Algolia#42226

Draft
julien-deramond wants to merge 3 commits intov6-devfrom
v6-dev-jd-use-pagefind
Draft

Docs: integrate search with Pagefind instead of Algolia#42226
julien-deramond wants to merge 3 commits intov6-devfrom
v6-dev-jd-use-pagefind

Conversation

@julien-deramond
Copy link
Copy Markdown
Member

@julien-deramond julien-deramond commented Mar 22, 2026 •
edited
Loading

Warning

Heavily draft

Description

This PR suggests to switch from Algolia to Pagefind; commonly used with Astro-based docs.

Checklist

  • Check configurations available in Pagefind for better results
  • Improve CSS rules for better rendering (current one is just a prototype)
    • Header's rendering
    • Results
  • Improve a11y
  • Clean up the branch (JS CSS, etc.)
  • Rendering with local build (npm run start)
  • Rendering with local build (npm run release ; npm run docs ; cd _site ; http-server)
  • Rendering with Netlify
  • Check pagefind 1.5.0 new features
  • Handle
  Pagefind found references to the Default UI (pagefind-ui.js)           │
│  on your site. The Default UI is supported and will continue            │
│  to work.                                                               │
│                                                                         │
│  As of 1.5.0, if you are setting up a new integration, use the          │
│  Component UI instead. It includes a search modal, better               │
│  accessibility and customization: https://pagefind.app/docs/search-ui/

@github-project-automation github-project-automation Bot moved this to Inbox in v6.0.0 Mar 22, 2026
julien-deramond
julien-deramond commented Mar 22, 2026
View reviewed changes
Comment thread package.json Outdated
"@babel/core": "^7.28.5",
"@babel/preset-env": "^7.28.5",
"@docsearch/js": "^3.9.0",
"pagefind": "^1.3.0",
Copy link
Copy Markdown
Member Author

@julien-deramond julien-deramond Mar 22, 2026 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We could use https://github.com/shishkin/astro-pagefind as it was prototyped at #41842 instead but there's always the question of how long would it be maintained. If we can make it work without too much efforts directly with pagefind, I'd stick with this solution.

Copy link
Copy Markdown
Contributor

@coliff coliff Apr 6, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

just in case you hadn't seen it... Pagefind 1.5.0 is out and has many great improvements!
https://pagefind.app/

Copy link
Copy Markdown
Member Author

@julien-deramond julien-deramond Apr 11, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for sharing, I've bumped pagefind to 1.5.0 🙏 I'll check the new features later.

@julien-deramond julien-deramond force-pushed the v6-dev-jd-use-pagefind branch from 5de5cf0 to b93ffb0 Compare March 22, 2026 09:09
@julien-deramond julien-deramond force-pushed the v6-dev-jd-use-pagefind branch from 5ddf8f4 to 773fb09 Compare April 11, 2026 19:23
codeCraft-Ritik
codeCraft-Ritik reviewed Apr 23, 2026
View reviewed changes
Copy link
Copy Markdown

@codeCraft-Ritik codeCraft-Ritik left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great proposal! Switching to Pagefind aligns well with Astro and should improve performance and flexibility.
Nice focus on a11y and UI improvements 👍

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

2 more reviewers

@coliff coliff coliff left review comments

@codeCraft-Ritik codeCraft-Ritik codeCraft-Ritik left review comments

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

docs v6

Projects

v6.0.0
Status: Inbox

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@julien-deramond @coliff @codeCraft-Ritik